schm-green-cip-eapi

(0 reviews)

API Reference (Chinese Version)

schm-green-cip-eapi

接口描述: 本地文件&oss文件以及公网可访问图片合规性校验接口,可支持多文件合规性校验,多oss文件合规性校以及公网可访问图片合规性校验(目前只支持图片类型文件)。
DEV地址(开发环境): https://schm-api-dev.shiseido.cn/schm-green-cip-eapi
UAT地址(测试环境): https://schm-api-test.shiseido.cn/schm-green-cip-eapi
PROD地址(生产环境): https://schm-api.shiseido.cn/schm-green-cip-eapi

1.身份认证

所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。

client_id: fa98****3452
client_secret: 108b****41f2

2.接口总览:

请求接口描述
/check本地文件&oss文件以及公网可访问图片合规性校验接口,可支持多文件合规性校验,多oss文件合规性校以及公网可访问图片合规性校验(目前只支持图片类型文件)。

完整调用地址为对应环境地址+接口地址,例如:

https://schm-api-test.shiseido.cn/schm-green-cip-eapi/check

3.接口调用说明

3.1 本地文件&oss文件以及公网可访问图片合规性校验接口

请求接口: /check
接口描述: 本地文件&oss文件以及公网可访问图片合规性校验接口,可支持多文件合规性校验,多oss文件合规性校以及公网可访问图片合规性校验(目前只支持图片类型文件)。
请求类型: HTTP POST

3.2 参数说明

headers参数: 除了client_id和client_secret参数外,还需额外传入以下参数(进行oss文件检验时,headers中需要传入bucket参数)

字段描述字段名称类型长度必填备注
oss库bucketstring目标oss库

body类型: multipart/form-data
注意: 该接口可支持本地文件、oss文件、公网可访问图片的合规性检验;进行本地图片检验时,只需要传入file文件即可,进行oss文件检验时,headers中需要传入bucket参数,body中需要传入oss中文件path,公网图片检验时,只需要传入imageUrl参数。

字段描述字段名称类型长度必填备注
文件filefile支持多文件上传,都传入一个file参数中,无需定义多个file参数(本地文件需要传入该参数),非图片类型文件不会进行合规性校验
oss文件路径pathstring多个oss文件路径按,分割,如:WMS/SAP/Xuhe/oss信息.txt,WMS/SAP/unknow/让人.png(oss文件需要传入该参数)
公网可访问图片的url地址imageUrlstring多个url地址按,分割,如:https://imgs.699pic.com/images/300/914/575.jpg!seo.v1,https://imgs.699pic.com/images/600/121/371.jpg!seo.v1

3.2 参数示例

headers参数:

resources/image-770efb9e-38f2-4fcf-9f45-bac7789fd901.png

本地文件:

resources/image-5b50081d-2ff3-46b8-a6dc-fd6bdc161a87.png

oss文件:

resources/image-2076c3eb-4da2-45c3-94eb-b79c15d95ef2.png

公网可访问图片:

resources/image-e38c66a0-359c-4416-b73c-7aef740ae2d4.png

3.3 返回值说明

字段描述字段名称类型必填备注
响应状态statusString"success" 表示成功
上传结果信息resultArray包含文件风险违规信息

上传结果信息 result:

字段描述字段名称类型长度是否必填备注
消息msgString检查成功该值为"success",以及会显示错误提示信息
文件名file_nameString本地文件和oss文件都会返回该文件名,网络图片则不显示该参数
公网图片urlimage_urlString
风险等级risk_levelStringnone-无风险,目前只支持图片校验风险违规,其他类型文件该值为null
风险信息risk_infoArray目前只支持图片校验风险违规,其他类型文件该值为null

风险信息 info:

字段描述字段名称类型长度是否必填备注
风险值confidenceString1~100,分值越大,风险越高,无风险该值为null
涉及违规内容labelString如:political_politicalFigure,涉及政治人物,无风险该值为nonLabel

3.4 返回值示例

本地文件/oss文件校验:

{
    "status": "success",
    "result": [
        {
            "msg": "success",
            "file_name": "让人.png",
            "risk_level": "none",
            "risk_info": [
                {
                    "confidence": null,
                    "label": "nonLabel"
                }
            ]
        },
        {
            "msg": "success",
            "file_name": "oss信息.txt",
            "risk_level": "none",
            "risk_info": [
                {
                    "confidence": null,
                    "label": "nonLabel"
                }
            ]
        }
    ]
}

网络图片校验

{
    "status": "success",
    "result": [
        {
            "msg": "success",
            "image_url": "https://imgs.699pic.com/images/300/914/575.jpg!seo.v1",
            "risk_level": "none",
            "risk_info": [
                {
                    "confidence": null,
                    "label": "nonLabel"
                }
            ]
        },
        {
            "msg": "success",
            "image_url": "https://imgs.699pic.com/images/600/121/371.jpg!seo.v1",
            "risk_level": "none",
            "risk_info": [
                {
                    "confidence": null,
                    "label": "nonLabel"
                }
            ]
        }
    ]
}

Reviews